home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / scherz programme / animan / animan52.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  20KB  |  312 lines

  1. @DATABASE
  2. @NODE MAIN "AniMan.Guide Table of Contents"
  3.      @{"1 - AniMan Principles of Operation             " LINK Principles}
  4.      @{"2 - AniMan Options                             " LINK Options}
  5.      @{"3 - Learning AniMan Commands                   " LINK Learning}
  6.      @{"4 - Loading, Modifying, Saving AniMan Commands " LINK Loading}
  7.      @{"5 - Use of CLI Commands                        " LINK Use}
  8.      @{"6 - Running AniMan                             " LINK Running}
  9.      @{"7 - AniMan Practical Considerations            " LINK Considerations}
  10.      @{"8 - Solving Problems                           " LINK Problems}
  11.      @{"9 - Version                                    " LINK Version}
  12.      @{"10 - Credits                                   " LINK Credits}
  13. @ENDNODE
  14. @NODE Principles "1 - AniMan Principles of Operation"
  15.     AniMan displays an animated talking head in a small window on the Amiga
  16. Workbench that responds to your voice commands spoken through the Perfect
  17. Sound 3, Sound Magic (Sound Master), DSS 8, or a Generic audio digitizer.
  18. AniMan uses the public domain voice.library of voice recognition functions to
  19. @{"learn" LINK Learning} and @{"recognize" LINK Running} spoken voice commands and corresponding @{"CLI Commands." LINK Use }
  20. These CLI commands are executed upon recognition of your spoken command and
  21. may be used to execute an ARexx script, give a single line CLI ARexx command,
  22. or execute any ordinary CLI command.
  23.     AniMan is designed to run on an Amiga Workbench screen having at least
  24. 64 colors and will automatically adapt to a wide variety of monitors and
  25. display modes.  AniMan requires AmigaDOS 3.0.
  26.     AniMan is completely multitasking and will operate either in the
  27. foreground or background, listening for your voice commands even while
  28. other programs may be running.  AniMan allows the use of voice commands to
  29. control programs which have an active ARexx port or to execute any CLI
  30. command by spoken voice command.  
  31.     AniMan should be copied into its own drawer along with the required
  32. AniMan.pixels and AniMan.phrases files.  AniMan will create configuration
  33. files and @{"voice command files" LINK Loading} that are best kept in a directory with
  34. Animan.  Voice.library must be copied to your libs: directory in order to
  35. run AniMan.
  36.     AniMan also uses the Amiga translator.library and the Amiga
  37. narrator.device which must be available as well.  Translator.library and
  38. narrator.device are available with the 2.0 Workbench and must be copied
  39. from there to your libs: and devs: directories, respectively.
  40. @ENDNODE
  41. @NODE Options "2 - AniMan Options"
  42.     The first step in using AniMan is to choose the audio digitizer to be
  43. used.  Make your selection from the "Option" menu.  You will have a choice
  44. of Perfect Sound 3, Sound Magic (Sound Master), DSS 8, or a Generic
  45. digitizer.  Your selection will be saved with your voice commands.  Note
  46. that your microphone must be connected to the right (not left) channel of
  47. the audio digitizer.
  48.     AniMan's voice recognition processing will operate either at high
  49. resolution or low resolution.  Make your choice from the Option menu.  High
  50. resolution is somewhat better at voice recognition, but requires nearly
  51. twice the time as low resolution to recognize a voice command.
  52. Your selection will be saved with your voice commands.
  53.     You also have a choice from the Option Menu of which CIAB Timer for
  54. AniMan to use in timing the intervals between audio samples.  Timer B is
  55. the normal selection, and you usually will not have to change it.  However,
  56. you may find some programs that are using Timer B themselves and will
  57. object if AniMan attempts to use Timer B.  For these cases, choose Timer A. 
  58. Your selection will be saved with your voice commands.
  59. @ENDNODE
  60. @NODE Learning "3 - Learning AniMan Commands"
  61. LEARNING COMMANDS
  62.     Before AniMan is used to recognize spoken commands, the program must
  63. first learn each voice command and associated CLI command.  After selecting
  64. the proper @{"audio digitizer," LINK Options} choose "New Commands" from the Function Menu to
  65. bring up the "Learn Commands" window containing string gadgets for each of
  66. 12 voice commands and 12 matching CLI commands.
  67.     To learn a voice command, type the command word or short phrase you
  68. have chosen in one of the string gadgets in the left hand column and strike
  69. the "Return" key.  You will then be presented with the "Learning" window
  70. for audio sampling of the voice command.  When you see "Ready to take first
  71. sample," click the "Sample" button and speak your chosen word or short     
  72. phrase into a microphone connected to the right channel of your audio
  73. digitizer.  In order to ensure a good audio sample the program examines
  74. the audio data for volume too low, volume too high (clipping), or for noisy
  75. input and you will be warned if these conditions exist.  If volume needs
  76. adjustment you may change your volume of speech, move your microphone, or
  77. change the gain of your audio digitizer and repeat the sample.  Volume must
  78. be MAXIMUM possible without clipping.  Try taking several samples, clicking
  79. the "Sample" button each time before speaking.  Adjust volume until the
  80. sample amplitude is the maximum possible without a "Volume too high"
  81. warning.  
  82.     Setting gain (or volume) to maximum without clipping is very important
  83. to operation of AniMan.  The MOST COMMON CAUSE of failure of AniMan to
  84. recognize voice commands is digitizer gain (volume) set too low.  The gain
  85. of the Perfect Sound 3 digitizer can be adjusted using the "Volume Up" and
  86. "Volume Down" buttons.  Perfect Sound 3 has 16 discrete gain steps. 
  87. Clicking the "Volume Up" or "Volume Down" buttons changes the gain by one
  88. step.  Adjusting gain of the Perfect Sound 3 digitizer can be confusing. 
  89. If you reach gain step 16, the next step up will take gain down to minimum
  90. step 1.  Likewise, if you reach minimum step 1, the next step down will
  91. take you to maximum step 16.  This can cause some confusion if you attempt
  92. to increase gain past maximum and find that gain has dropped to minimum.   
  93.     The gain of the DSS 8 digitizer can also be adjusted using the "Volume
  94. Up" and "Volume Down" buttons.  DSS 8 has 8 discrete gain steps, and
  95. clicking these buttons changes the gain by one step.  DSS 8 gain is easier
  96. to control since it will not jump from maximum to minimum unexpectedly.
  97.     The gain of the Sound Master digitizer is adjusted using a sliding
  98. control knob on the unit.  Increase or decrease gain until the maximum
  99. level without severe clipping is achieved.  
  100.     When you see "Sample OK. Recommend accept," click the "Accept" button
  101. to store the audio sample of this voice command.  This process is repeated
  102. for a second and third audio sample of the voice command.  When you see
  103. "Ready to take second sample," and "Ready to take final sample," just 
  104. repeat the voice command again into your microphone and "Accept" each 
  105. sample when appropriate.  Internally, AniMan combines these three audio
  106. samples into a frequency/time map or voice print of the command.  This
  107. voice print will be stored along with those of the other spoken commands in
  108. the AniMan vocabulary for use in recognizing spoken commands.
  109.     When three audio samples have been accepted and a voice print of the
  110. command stored internally, you will be returned to the "Learn Commands"
  111. window where you must then type the matching @{"CLI command" LINK Use} into its
  112. appropriate string gadget in the right hand column.
  113. HOW MANY COMMANDS
  114.     The "Learn Commands" window displays one of four pages of voice
  115. commands.  Each page can hold 12 commands for a total of 48 possible
  116. commands.  Choose Page One through Page Four from the "Page Select" menu. 
  117. Add your commands beginning with Page One, filling the later pages as more
  118. commands are needed.  Try not to leave gaps in the vocabulary of voice
  119. commands, but group your commands together on as few pages as possible.
  120.     As more commands are added, the time required for AniMan to recognize a
  121. voice command increases in proportion.  More than one page (or 12 commands)
  122. is not recommended unless you have an accelerated Amiga.
  123. LEARNING DIRECTIONS
  124.     In addition to learning voice commands, AniMan must also learn to
  125. recognize four spoken directions corresponding to "Cancel AniMan Command,"
  126. "Run AmigaGuide," "Read Some Poetry," and "Quit AniMan."  Choose "Learn
  127. Directions" from the Function Menu, and @{"learn" LINK Learning} these spoken directions in
  128. the same manner that you learned the AniMan commands.  These directions
  129. will be also be saved in the command files that you create.
  130.     After recognizing a voice command, AniMan will speak his intention to
  131. execute the matching CLI command.  If you want to cancel this command, you
  132. must speak the words chosen for "Cancel AniMan Command" within about five
  133. seconds.  Or you can correct AniMan within this time period by repeating
  134. the desired command.  If you do not cancel or correct the command, AniMan
  135. will assume that you agree with his interpretation and will proceed.
  136.     AniMan will run AmigaGuide and display this information file when the
  137. words chosen for "Run AmigaGuide" are recognized.
  138.     When AniMan recognizes the spoken words learned for "Read Some Poetry,"
  139. one verse of poetry from "The Raven" by Edgar Allan Poe will be recited. 
  140. AniMan can recite all eighteen verses of "The Raven."
  141.     And finally, when AniMan recognizes the words chosen to represent "Quit
  142. AniMan," the program will close and return you to the Workbench Screen.
  143. @ENDNODE
  144. @NODE Loading "4 - Loading, Modifying, and Saving AniMan Commands"
  145.     Voice command files can be saved by choosing the "Save Commands" menu
  146. item from the Function Menu.  Different command files can be saved for
  147. different uses.  It is important to save your command file as the last
  148. thing you do before quitting AniMan.  Doing so will save any changes to
  149. your commands for future use.  AniMan will also remember the name of the
  150. file that you save and load these commands automatically the next time you
  151. run AniMan.
  152.     You can recall previously saved commands by selecting the "Load
  153. Commands" menu item from the Function Menu.  These commands can then be
  154. used to run AniMan without any relearning.  If you need to make
  155. modifications, choose "Mod Commands" from the Function Menu and proceed as
  156. described under @{"LEARNING COMMANDS" LINK Learning} above to modify or add commands to the
  157. vocabulary.
  158. @ENDNODE
  159. @NODE USE "5 - Uses of AniMan Commands"
  160.     CLI commands are matched to each of your @{"voice commands" LINK Learning} by typing them
  161. into the CLI string gadgets in the right hand column of the "Learn
  162. Commands" window.  The CLI commands that you will match to your voice 
  163. commands and save in a voice command file have three possible uses.  These
  164. are to execute ARexx scripts, ARexx commands, or ordinary CLI commands as
  165. described below.  You must always use FULL PATH NAMES for CLI commands. 
  166. AREXX SCRIPTS:
  167.     You can use your CLI command to execute an ARexx script.  For example,
  168. suppose you have stored an Arexx script named "DoSomething.rexx" in ram:.
  169. The proper text to enter in the CLI Command string gadget will be:
  170.                  sys:rexxc/rx ram:DoSomething.rexx
  171. When the voice command that you stored for this CLI command is recognized,
  172. your ARexx script will then be executed just as if you had typed the text
  173. at the CLI.  Full path names are always used to avoid confusion.
  174. AREXX COMMANDS:
  175.     You can use your CLI command to execute a single line ARexx command. 
  176. For example, suppose you want to send the ARexx message "MYCOMMAND" to an
  177. Arexx port named "AREXXPORT."  The proper CLI command in this case will be:
  178.                 sys:rexxc/rx "ADDRESS AREXXPORT MYCOMMAND"
  179. CLI COMMANDS:
  180.     You can also execute any CLI command, completely independent of ARexx. 
  181. For example, if you are using a voice command to start a game named
  182. "MindlessGame" in df0:, the proper CLI command to store will be: 
  183.                          run df0:MindlessGame 
  184. COMMAND MODIFIERS:
  185.     AniMan recognizes two command modifiers, "TALK", and "LOAD", which
  186. change the way in which CLI commands are executed.  These modifiers must be
  187. typed (all capitals) in the CLI Command string gadget ahead of the CLI
  188. command.  
  189.     Use the "TALK" modifier if you wish AniMan to speak back to you the
  190. text you have typed in the CLI Command string buffer.  AniMan will stay in
  191. the foreground and speak back the text you have specified.  For example, 
  192. you might have a voice command such as "How are you?"  The CLI command
  193. could be "TALK What's it to you, buddy?"  AniMan will answer your question
  194. "How are you?" with "What's it to you, buddy?" 
  195.     You can also use a voice command to load another file of voice commands
  196. which has been @{"saved previously." LINK Loading}  To do this, precede your CLI command with
  197. the word "LOAD".  The CLI string following "LOAD" will be interpreted as a
  198. file name of voice commands to be loaded into AniMan.  For example, if you
  199. have a voice command file by the name of "dh0:Voice.Commands", the proper
  200. command to type in the CLI Command string gadget will be "LOAD
  201. dh0:voice.commands".  When AniMan recognizes this command, the voice prints
  202. and CLI commands in Voice.Commands will be loaded into AniMan and will take
  203. control.  In this way you can minimize the number of commands (and thus the
  204. time required for recognition) by grouping small numbers of similar
  205. commands together and saving each group as a separate command file.  Then
  206. use the LOAD command to move from one file to another.
  207. @ENDNODE
  208. @NODE Running "6 - Running AniMan"
  209. SPEAKING TO ANIMAN
  210.     Once AniMan has learned @{"commands" LINK Learning} and @{"directions," LINK learning 68} you may return to the
  211. Workbench Screen where the animated talking head will then appear in its
  212. own window and await your voice command.  Speak your commands slowly and
  213. distinctly into the microphone attached to your @{"audio digitizer," LINK Options} and AniMan
  214. will attempt to match your command to the stored vocabulary of learned
  215. commands.  AniMan will then announce his intention to execute your command.
  216. If you do not cancel the command or speak another command within about five
  217. seconds, AniMan proceed to execute the expected CLI command.
  218.     Note that AniMan LISTENS for your command ONLY WHEN HIS HEAD IS FACING
  219. AWAY FROM YOU.  When he turns to face you and speak, he is not listening to
  220. you at all, but plans to speak his mind.  
  221.     If AniMan tells you frequently that "I do not understand," or " I
  222. cannot hear you," you probably have the audio digitizer gain (volume) set
  223. too low.  If you hear "You are speaking too loudly" very often, the volume
  224. may be set too high.  Select "Adjust Volume" from the Function menu to
  225. bring up a window for display of the sampled audio data.  This window is
  226. identical to that used for learning voice commands.  However, it allows you
  227. to experiment with the gain (volume) control without making unwanted
  228. changes to your stored voice commands.  Experiment with this window to
  229. @{"adjust volume" LINK Learning 24} to the MAXIMUM value possible without clipping of the audio
  230. signal.
  231.     If AniMan tells you frequently that "It is too noisy in here," it means
  232. that there is too much background noise, or that you are bumping the
  233. microphone around causing AniMan to become confused.  Handle the microphone
  234. carefully, and eliminate as much background noise as possible.
  235. ANIMAN WINDOW OPERATION:
  236.     When the AniMan window is active, AniMan will become impatient if he
  237. hears nothing from you and will have witty things to say chosen at random
  238. from the AniMan.phrases file.  You may edit or create your own
  239. AniMan.phrases file using any ASCII text editor.  This file consists of a
  240. sequence of English language phrases, each PRECEDED by "****" to mark the
  241. beginning of a new phrase.  Phonetic spelling may be needed for some words.
  242.     When the AniMan window is inactive, AniMan will close his eyes and
  243. doze.  However, he is still listening for your commands, and will wake to
  244. execute any recognized command.  The AniMan window may also be pushed into
  245. the background.  However, AniMan will still be listening for your commands
  246. even while operating in the background.
  247.     All Function Menu and Option Menu selections are available when the
  248. AniMan window is active.  However, when AniMan is speaking, menu operations
  249. are temporarily suspended.  Wait for AniMan to finish speaking before
  250. making any menu selections.
  251. @ENDNODE
  252. @NODE Considerations "7 - Practical Considerations"
  253.     The choice of command words or phrases is important to successful use
  254. of AniMan.  Words that sound distinctly different from each other will be 
  255. more reliably recognized.  Words that rhyme are poor choices.  "Seven" and 
  256. "eleven," or "make" and "break" will frequently be confused by AniMan. 
  257. Even with distinctly different words, you must diligently pronounce each
  258. syllable of each word slowly, distinctly, and forcefully.
  259.     The frequency maps of spoken command words will vary due to any change
  260. in the pitch or rate of your speech.  If you have a cold, or become
  261. impatient and speak at a faster rate, AniMan may not recognize your
  262. commands.  Often, the only cure is to relearn a difficult word.            
  263.     An expensive high bandwidth microphone is not necessary or desirable. 
  264. It can be helpful, though, to have a microphone with a push button on-off
  265. switch.  A continuously active microphone will sometimes confuse AniMan.  
  266.     And finally, you will find some words that just don't work well with
  267. AniMan.  The simplified voice recognition process used by AniMan is very
  268. fast in operation, but cannot handle all circumstances.  If this happens,
  269. keep cool and pick another word or phrase.
  270. @ENDNODE
  271. @NODE Problems "8 - Solving Problems"
  272. INCORRECT AUDIO DIGITIZER
  273.     If you have not selected the correct audio digitizer, AniMan may give a
  274. continuous string of "I do not understand," or "It is too noisy in here,"
  275. or "I can not hear you," or "You are speaking too loudly, and refuse to
  276. recognize any commands.  Select the option for the correct @{"audio digitizer" LINK Options}
  277. from the Options menu.
  278. VOICE COMMANDS NOT RECOGNIZED
  279.    The most common cause for failure of AniMan to recognize your voice
  280. commands is audio @{"digitizer gain" LINK Learning 24} set too low.  Of course, you must have
  281. @{"learned" LINK Learning} or @{"loaded" LINK Loading} commands before they can be recognized.  Also be sure
  282. that your microphone is connected to the right channel of the audio
  283. digitizer.
  284. CLI COMMANDS NOT EXECUTED
  285.     If you voice commands are recognized, but the corresponding @{"CLI command" LINK Use}
  286. is not executed, it is likely that your command is defective or does not
  287. contain a full path name for all required files.  Try out your CLI commands
  288. independently in an AmigaShell, with your current directory set to the directory
  289. containing AniMan, to see if they will work correctly.
  290. AMIGAGUIDE DOES NOT APPEAR
  291.    If your AmigaGuide command is recognized, but AmigaGuide does not appear, check
  292. to see that the AmigaGuide program is installed in sys:utilities and that the
  293. database named AniMan52.Guide is available in the same directory as AniMan.
  294. @ENDNODE
  295. @NODE Version "9 - Version"
  296.     This is version 5.2 of AniMan which will automatically configure to
  297. NTSC, PAL, or MultiSync monitors, runs in a small window in full color on
  298. the Amiga Workbench, and supports either Perfect Sound 3, Sound Magic
  299. (Sound Master), DSS 8, and Generic audio digitizers.  Voice.library version
  300. 7.0 or higher is required.  AmigaDOS 3.0 is also required.
  301. @ENDNODE
  302. @NODE Credits "10 - Credits"
  303.     The AniMan head figure was originally created by Greg Denby.  Without
  304. Greg's artistic talent, AniMan would not have been possible.  AniMan and
  305. voice.library were written by Richard Horne.  Zap improved voice.library 
  306. by suggesting methods to increase the speed of voice recognition. And Mark
  307. Moore uncovered the secrets to programming the DSS 8 digitizer.
  308.     AniMan and voice.library were created for the enjoyment of the Amiga
  309. community and are freely distributable in the public domain.  Questions,
  310. comments, and constructive criticism are welcome.
  311. @ENDNODE
  312.